home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archives / Replacements / AKCC35.lha / Docs / English / Tips.doc < prev   
Encoding:
Text File  |  1994-12-30  |  19.0 KB  |  573 lines
  1.  
  2.                            AKCC V3.5
  3.  
  4.                 - Additional Manual for AKCC in English -
  5.  
  6.                      © 1989-94 by Andreas R. Kleinert.
  7.                          All rights reserved.
  8.  
  9.                Date of last changes : 27.07.1994
  10.  
  11.  
  12.  
  13. =============================================================================
  14.  Common Information :
  15. =============================================================================
  16.  
  17.  All AKCC-Commands are self-explaining. They print an english information
  18.  text, when started with "?" (e.g. "ExtShow ?").
  19.  More and detailed hints are written down here.
  20.  
  21.  The AKCC-Commands are written and tested under OS 3.00 since a long time.
  22.  So full compatibility is ensured.
  23.  All commands need at least Kickstart V1.2, but the following commands
  24.  do also contain special code-modules for OS V2.04+ :
  25.  
  26.   - ExtShow
  27.   - KAssign
  28.   - DosRequest
  29.  
  30.  Detailed Information on the single commands and their sub-groups follow.
  31.  
  32.  
  33.  Commands with "-a"-Support :
  34.  =========================================================================
  35.  
  36.  "-a" stands for "-all" and describes recursive, that means (in this case)
  37.  complete access to ALL sub-directories by the specific command.
  38.  
  39.  
  40.  Commands with "*"/"#?"/"?" WildCard-Support :
  41.  =========================================================================
  42.  
  43.  These WildCards are equivalent to the Standard-AmigaDOS-WildCards
  44.  "#?" and the ARP-WildCard "*" (as under MS-DOS or other Operating Systems).
  45.  It is also possible to use more than one WildCard in a name-descriptor,
  46.  which is not common to all of the Standard-AmigaDOS-Commands (especially
  47.  under OS <= V1.3) :
  48.  
  49.     e.g. : - Kill Vie*l*
  50.  
  51.              (deletes e.g. "Viele", "VielMehr", "VierBilder", etc.)
  52.  
  53.            - ExtShow sta*t*
  54.  
  55.               or
  56.  
  57.              ExtShow sta#?t#?
  58.  
  59.              (lists e.g. "startup-sequence".)
  60.  
  61.  The special SingleChar-WildCard of AmigaDOS ("?") is also supported,
  62.  which allows to replace only one (or none) char instead of an unlimited
  63.  number.
  64.  
  65.  All users of OS V2.04 or greater have ADDITIONALLY access to the new
  66.  WildCards of V37-DOS, so that at first DOS-PatternMatching is used,
  67.  and if the pattern "still does not fit" after that, the internal
  68.  routines of "akcc_gen0.library" are used instead.
  69.  This results in the following additional WildCards :
  70.  
  71.      ~                         logical NOT
  72.  
  73.      (String_1|...|String_n)   logical OR  (brackets allowed)
  74.  
  75.   Combinations are possible.
  76.   Also the "WildStar" ("*") can be used, because the "akcc_gen0.library"
  77.   activates it automatically.
  78.  
  79. =============================================================================
  80.  
  81.     CheckExec
  82.     =========================================================================
  83.  
  84.     CheckExec prints out informationen about the system's configuration :
  85.  
  86.     e.g. CPU, FPU, PAL/NTSC, various addresses,
  87.          Viruses ?, ...
  88.  
  89.     CheckExec also allows to view Bootblocks of Disks :
  90.  
  91.      e.g. CheckExec CHECK DF0:
  92.  
  93.     displays the Bootblock of a disk in the internal drive "DF0:".
  94.  
  95.     The "FORMAT [DF(0|1|2|3):] allows to format diskettes.
  96.     Only 837 KB disks are supported.
  97.     This option may only concern users of OS 1.2 so far.
  98.  
  99.  
  100.     DateAct
  101.     =========================================================================
  102.  
  103.     This command merges two of the Standard-AmigaDOS-Commands.
  104.     It changes the internal Clock (CIA-Timer based) as well as
  105.     it is able to access the (optional) batterie-buffered realtime-clock
  106.     (only supports type MSM 6242 B, e.g. in most im Amiga 500 plus models).
  107.  
  108.     Meaning of the options :
  109.  
  110.      - <Date description>          CIA-Timer are set new
  111.      - LOAD                        Loads CIA-Timer with realtime-clock
  112.                                    values and displays them
  113.      - SAVE <Date description>     Set realtime-clock to date
  114.  
  115.     Direct copies from CIA-time to realtime-clock are not supported.
  116.     The reverse way should be gone always.
  117.     (First set realtime-clock, then copy to Timers, or even not.)
  118.  
  119.  
  120.     Display
  121.     =========================================================================
  122.  
  123.     Display support printing files in different ways, e.g.
  124.     as ASCII, hexadecimal, octal, C- and Assembler-SourceCode,
  125.     to the Console (default) or any other DOS-Device, as well as
  126.     into a file.
  127.  
  128.      Normal/ASCII     : (Default)
  129.      Hexadecimal      : HEX
  130.      Octal            : OCT
  131.      C-Source         : C             (Byte-Array)
  132.      Assembler-Source : ASM           (dc.b-field)
  133.  
  134.  
  135.     DosRequest
  136.     =========================================================================
  137.  
  138.     This program allows easy opening of Requesters from Batch-Files,
  139.     to let the user decide, what actions to perform next.
  140.     Use this excerpt from a Batch-File as a demonstration :
  141.  
  142.      ; Begin of Batch-File
  143.  
  144.      DosRequest "Should I continue ?" "Yes" "No"
  145.      if warn
  146.       echo "You selected 'No' !"
  147.      else
  148.       echo "You selected 'Yes' !"
  149.      endif
  150.  
  151.      ; End of Batch-File
  152.  
  153.     Under OS V2.04+ "AutoRequest()" will be replaced by the V37-Intuition-
  154.     Function "EasyRequest()".
  155.     This allows greater comfort and higher flexibility for requesters, then.
  156.  
  157.  
  158.     EnvAct
  159.     =========================================================================
  160.  
  161.     Selection of a specific action is done via commandline parameters :
  162.  
  163.      EnvAct INIT <...>        - creates ENV: (NewDir + KAssign)
  164.      EnvAct WRITE <...>       - writes an Env-Variable
  165.      EnvAct READ <...>        - reads an Env-Variable
  166.      EnvAct STREAM <...>      - prints out the content of an Env-Variable
  167.      EnvAct ERASE <...>       - erases an Env-Variable
  168.  
  169.     STREAM results in printing out only the content of the Variablen
  170.     (only a linefeed attached, no more explaining texts), so that
  171.     the result may be used with other programs (e.g. via Backticks
  172.     under OS V2.04+).
  173.  
  174.     Existance of "ENV:" is needed for using this command.
  175.  
  176.  
  177.     ExecLibs
  178.     =========================================================================
  179.  
  180.     ExecLibs may also load Libraries and flush unused ones out of memory
  181.     (if #=0, and the Library has been loaded to RAM and is not a ROM-
  182.     resident one), if the specific Library supports this.
  183.  
  184.     ExecLibs offers basically the same options in using WildCards (for
  185.     removing) as "KillTask" or "PriSet".
  186.     But always ALL Libraries, which match the WildCard string are removed.
  187.     But - different to the handling of Tasks - there are never two or
  188.     more libraries with exactly the same name, which makes selection
  189.     somewhat easier.
  190.  
  191.     When loading Libraries (from "LIBS:") the full name of the Library
  192.     (as e.g. "42.library") has to be specified.
  193.  
  194.     "akcc_gen0.library" cannot be removed via ExecLibs, because ExecLibs
  195.     itself does use it.
  196.     Use "flushlibs" (Workbench-Menu) instead to do this (available
  197.     when started in "-debug" mode).
  198.  
  199.  
  200.     List of options :
  201.     -----------------
  202.  
  203.      ExecLibs LOAD <Name>
  204.  
  205.        - Loads a Library from LIBS: to memory
  206.  
  207.      ExecLibs KILL <NamePattern>
  208.  
  209.        - Removes all the Libraries from memory, which match the
  210.          pattern (WildCards : "?", "#?", "*").
  211.  
  212.          Attention : Somtimes two or more calls are useful, because may
  213.                      Libraries also open other Libraries, which then can
  214.                      be removed also later.
  215.  
  216.      ExecLibs VIEW
  217.  
  218.        - All resident Libraries are displayed.
  219.          Option is not needed (typing "ExecLibs" suffices).
  220.  
  221.  
  222.     You may also access the command "ExecDevs" in the same way as this has
  223.     been described above for "ExecLibs".
  224.  
  225.  
  226.     ExecMem
  227.     =========================================================================
  228.  
  229.     Display free memory and allos addiotional options :
  230.     The results may be written to an Environment-Variable (e.g. for use
  231.     by an other program).
  232.  
  233.      e.g. :            ExecMem CHIP VAR=<Variable-Name>
  234.  
  235.                        (writes size of free CHIP mem to ENV:<Variable-Name>)
  236.  
  237.      Syntax :
  238.  
  239.                                1. ExecMem
  240.  
  241.                                   => print out complete information
  242.  
  243.                                2. ExecMem <type of memory>
  244.  
  245.                                   allowed types :
  246.  
  247.                                   CHIP -> CHIP-Memory
  248.                                   FAST -> FAST-Memory
  249.                                   SUM  -> CHIP- & FAST-Memory
  250.  
  251.                                   => print out specific information only
  252.  
  253.                                3. ExecMem <type> VAR=<Variable-Name>
  254.  
  255.                                   => writes size of free memory of a
  256.                                      specific type to an Env-Variable
  257.  
  258.  
  259.     FullPath
  260.     =========================================================================
  261.  
  262.     FullPath replaces the Standard-Command Path in a way, which
  263.     is especially useful for HardDisk owners :
  264.  
  265.     Usually there are masses of sub-directories on a HardDisk, of which
  266.     many also have to be seacherd for commands.
  267.     This might be frustratin, if the most-often used commands are placed
  268.     in a directory, which is placed at the end of the search-list.
  269.     Even a fast HardDisk takes some time to load a command, then.
  270.  
  271.     FullPath allows to declare a List of Paths (from a File) as the
  272.     current List, where also the order of the entries is respected
  273.     (first Path at first, last Path at last).
  274.     The current directory is always searched at first, indepently from
  275.     that.
  276.  
  277.     Another adavantage : You only have to call one command, no matter
  278.                          if there are e.g. 30 Paths to be searched.
  279.  
  280.     Attention : The old PathList is always deleted !
  281.  
  282.     Tip : "C:" is usually searched at last, no matter if it is actually
  283.           in the list or not.
  284.           If you specify it at the begining of the list, it will be
  285.           be searched directly after the current directory.
  286.           Very useful !
  287.  
  288.     An example list :
  289.  
  290.     C:
  291.     SYS:
  292.     SYS:System
  293.     SYS:Tools
  294.     SYS:Utilities
  295.  
  296.     A new line for any new entry !!!
  297.  
  298.     When calling from CLI, there also may be added/removed single
  299.     entries via ADD/REMOVE.
  300.  
  301.  
  302.     HunkShow
  303.     =========================================================================
  304.  
  305.     This program show the Hunks of Program- or Objekt-Files
  306.     (only SAS/Lattice-compatible formats).
  307.     It also knows the follwing file-types :
  308.  
  309.      1a) FORM-????              (IFF-Files)
  310.       b) LIST,PROP,CAT          (extended IFF-Files)
  311.      2)  PowerPacker 3.0a/b     (packed programm -> PowerPacker)
  312.      3)  PP20                   (packed file     -> PowerPacker)
  313.      4)  -lh?-                  (archive in the "-lh?-" format)
  314.      5)  MMD0, MMD1             (MED-Module, OctaMED-Module)
  315.      6)  MED                    (MED-Sound)
  316.      7)  HDBackup Logfile       (Logfile for HDBackup of WB V2.04+)
  317.      8)  .key                   (many batch-files begin this way)
  318.      9)  .info                  (Info-File of Workbench V1.x+)
  319.     10)  ZOO                    (Archive in the "ZOO"-Format)
  320.     11)  ZOM                    (Archive of ZOOM)
  321.     12)  TFMX-SONG              (TFMX-Sound-Module)
  322.     13)  FC                     (Future_Composer-Sound-Module)
  323.     14)  RIFF-????              (RIFF-File, PC-Standard)
  324.     15)  AmigaGuide File        (AmigaGuide Online-Documentation)
  325.     16)  VOC SoundSample File   ("Creative Voice File"-Sample)
  326.  
  327.  
  328.     KScroller
  329.     =========================================================================
  330.  
  331.     This program allows to use an ASCII file as the source for a simple
  332.     "Text-Scroller" in the CLI/Shell (various speeds).
  333.     When combined with "Texter" there are offered many possibilities
  334.     for printing texts in the CLI/Shell.
  335.  
  336.  
  337.     KillTask
  338.     =========================================================================
  339.  
  340.     There are two possibilities to use KillTask, to remove Tasks from
  341.     the system :
  342.  
  343.     1. "BREAK"
  344.  
  345.     This does never affect the system and is nearly always SAFE.
  346.     Any available CTRL-Break-Signale will be sent to the Task, so that
  347.     it will immediately, if it supports one of them.
  348.     Don't forget the keyword "BREAK", which is the only difference
  349.     the method two.
  350.     Example :
  351.  
  352.                KillTask BREAK Exchange
  353.  
  354.  
  355.     2. "REMTASK"
  356.  
  357.     This one will remove the Task via Exec's "RemTask()" ALWAYS.
  358.  
  359.     Removing tasks this ways has many (almost only) disadvantages, but
  360.     is useful to remove tasks, which crashed "silently".
  361.  
  362.     KillTask does is not case-sensitive, concerning the Task-Names,
  363.     which makes usage much easier.
  364.  
  365.     Also usage of WildCards, as with the file-orientated commands,
  366.     is supported ('#?'/'*'/'?').
  367.  
  368.     Basically the first Task, which fits the name or pattern is removed,
  369.     but if you specify the option "-a", ALL matching Tasks/Processes
  370.     will be removed instead.
  371.  
  372.      Examples :
  373.  
  374.          KillTask THISONE             (kills current task : should NEVER
  375.                                        be done)
  376.  
  377.          KillTask "Background CLI"    (kills first task named
  378.                                        "Background CLI")
  379.  
  380.          KillTask "Background CLI" -a (kills ALL tasks named
  381.                                        "Background CLI")
  382.  
  383.          KillTask "Back*"             (kills first task beginning with
  384.                                        "Back")
  385.  
  386.          KillTask "Back*" -a          (kills ALL tasks beginning with
  387.                                        "Back")
  388.  
  389.  
  390.  
  391.     Attention : If any of the REMOVEd (not BREAKed) tasks still had any
  392.                 resources allocated, e.g. opened Windows, those will NOT
  393.                 be given free. (You should minimize the Window's sizes.
  394.                 The next reset will clear this up.)
  395.  
  396.  
  397.     KInfo
  398.     =========================================================================
  399.  
  400.     Meaning of the "status" field :
  401.  
  402.      "NoWrite" : write-protected
  403.      "Val'ing" : (at the moment) not validated
  404.      "Valid"   : valid and not write-protected
  405.      "???????" : unknown or invalid status-value
  406.  
  407.     Volume-Type :
  408.  
  409.      string              meaning                    since OS    DOS-ID
  410.  
  411.      "unreadable Disk"   <-                                     'BAD\0'
  412.      "no Disk present"   <-                                     -1
  413.      "not a DOS-Disk "   <-                                     'NDOS'
  414.      "OFS            "   OldFileSystem                          'DOS\0'
  415.      "FFS            "   FastFileSystem             V1.3        'DOS\1'
  416.      "OFS INTL       "   international OFS          V2.04/3.00  'DOS\2'
  417.      "FFS INTL       "   international FFS          V2.04/3.00  'DOS\3'
  418.      "OFS INTL CACHE "   international OFS,   Cache V3.00       'DOS\4'
  419.      "FFS INTL CACHE "   international FFS,   Cache V3.00       'DOS\5'
  420.      "Kickstart-Disk "   Kickstart-Diskette                     'KICK'
  421.      "MSDOS-Disk     "   PC-Formatted Diskette      V2.04/V3.00 'MSD\0'
  422.  
  423.     When entering an unknown DOS-ID, the Hex-Value will be printed
  424.     like in C ("0x...").
  425.  
  426.     The (international) FileSystems with DirectoryCache (DirCache)
  427.     are also described as "DCFS" sometimes.
  428.     But because the are two available of this kind, we do not use
  429.     this description here.
  430.  
  431.     The "By/Blo" value describes the number of Bytes per Block, which
  432.     the correspondings File-System uses. These are e.g. 488 for
  433.     OFS-Disks, 512 for FFS-Disks and 1024 for the Ram-Disk.
  434.  
  435.     Less information on the structure of the saved data (per Block)±t
  436.     results in a higher diskspace with FFS-Disks, compared against
  437.     the old OFS-Disks (24 Bytes additionally per Block).
  438.  
  439.  
  440.     LED
  441.     =========================================================================
  442.  
  443.     The LED command support batch files, in a way that its return code
  444.     is "boolean", when started with the "-batch" option.
  445.     Example :
  446.  
  447.      ; Begin of Batch-File
  448.  
  449.      LED -batch
  450.      if warn
  451.       echo "LED is ON !!!"
  452.      else
  453.       echo "LED is OFF !!!"
  454.      endif
  455.  
  456.      ; End of Batch-File
  457.  
  458.  
  459.     LED may be useful, if e.g.
  460.  
  461.      - Soundprogramms "forgot", to turn the LED (again) ON or OFF
  462.      - the LED is not visible (tower construction or defect LED)
  463.      - the LED should be controlled automaticalle (e.g. from Batch-Files)
  464.      - and many more
  465.  
  466.  
  467.     Move
  468.     =========================================================================
  469.  
  470.     This command allows "moving" of files by "deletion-after-copy".
  471.     So files may transferred from one directory to another by copying them
  472.     and then deleting the source.
  473.     This is a replacement for the "Rename" command, if it is to be used
  474.     "across device borders".
  475.  
  476.  
  477.     PrefSet
  478.     =========================================================================
  479.  
  480.     PrefSet is a kind of "Mini-Preferences" for the CLI.
  481.     Modifyable parameters are similar to the standard Preferences-programs,
  482.     but easier to set.
  483.     Useful for "CLI/Shell-only" users.
  484.  
  485.     Warning :
  486.  
  487.     - Keyrepeat values should be modified with care, because they
  488.       may affect any further keyboard operation very much.
  489.     - Under OS V2.04+ you should use the new preferences instead
  490.       (althoigh this program is still compatible).
  491.     - The "CLI - ON/OFF" option only works under OS-Versions below or
  492.       similar to V1.2. Since OS V1.3 this one is obsolete (ignored).
  493.  
  494.  
  495.     PriSet
  496.     =========================================================================
  497.  
  498.     Priorities should be between -20 and +20 (better : -5 / +5),
  499.     so that the task-switching is not affected in any way.
  500.     Common values are : -1 / 0 / 1.
  501.  
  502.     PriSet offers the same WildCard options as e.g. also "KillTask".
  503.  
  504.  
  505.     Texter
  506.     =========================================================================
  507.  
  508.     All font-attributes and other settings may be modified via special
  509.     controlcodes (no ESCAPE-sequences needed).
  510.     Example :
  511.  
  512.       Texter "\B\I\C=0,1Hello !\N\C=1,0" >PRT:
  513.  
  514.     Results in bold, italic "Hello !", with foreground color 0 and
  515.     background color 1 (passed to printer).
  516.     After that the old settings are restored.
  517.  
  518.     Possible controlcodes :
  519.  
  520.     atributes :
  521.                       \N      : normal
  522.                       \B      : bold
  523.                       \I      : italics
  524.                       \U      : underlined
  525.                       \R      : reverse
  526.  
  527.     colors :
  528.  
  529.                       \C=<FG>,<BG>
  530.  
  531.     characters :
  532.                       \\      : "\"
  533.                       \42     : " itself
  534.  
  535.     format control codes :
  536.  
  537.                       \n      : linefeed
  538.                       \b      : backspace
  539.                       \f      : clrscr
  540.                       \t      : TAB
  541.                       \r      : carriage return
  542.  
  543.  
  544.     Font attributes always have to be specified BEFORE colors, because
  545.     otherwise the colors would be reset again when setting the attributes.
  546.  
  547.  
  548.     WinAct
  549.     =========================================================================
  550.  
  551.     This command allows the modify the active CLI-/Shell-Window in
  552.     an easy way (e.g. fromout Batch-Files) :
  553.  
  554.     Size-adjustment options :
  555.  
  556.       - PAL         (640 / 256)
  557.       - NTSC        (640 / 200)
  558.       - BIGGEST     (Max / Max)    <- see Preferences
  559.       - X=<x> Y=<y> ( x  /  y )    <- First X, then Y (only TOGETHER)
  560.  
  561.     Position-adjustment options :
  562.  
  563.       - POSLEFT     (Window will be moved to upper, left corner.)
  564.  
  565.     Other options :
  566.  
  567.       - NAME=<Name> (Window title will be changed.)
  568.  
  569.  
  570. =============================================================================
  571.  
  572.  
  573.